home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / SOX10DOS.ZIP / README < prev    next >
Text File  |  1993-10-04  |  6KB  |  169 lines
  1.  
  2.  
  3.         ST: Sound Tools
  4.  
  5.  
  6.  
  7. ST translates sound samples between different file formats,
  8. and performs various sound effects.
  9.  
  10. This release understands "raw" files in various binary formats,
  11. raw textual data,
  12. Sound Blaster .VOC files, IRCAM SoundFile files, SUN Sparcstation 
  13. .au files, mutant DEC .au files, Apple/SGI AIFF files, 
  14. CD-R (music CD format), Macintosh HCOM files, Sounder files, 
  15. NeXT .snd files, SUN ADPCM (compressed) .au files,
  16. and Soundtool (DOS) files.
  17.  
  18. The sound effects include changing the sample rate, adding echo 
  19. delay lines, applying low-, high, and band-pass filtering, 
  20. reversing a sample in order to search for Satanic messages,
  21. and the infamous Fender Vibro effect.
  22.  
  23. History:
  24. This is the tenth release of the Sound Tools.  Patchlevel 11.
  25. All previous releases went out on alt.sources.  This one should
  26. go out on comp.sources.misc, if all goes well.
  27.  
  28. There is a nice graphical front-end for the NeXT
  29. called GISO.  Check the comp.sys.next group
  30. or poke around the NeXT binary sites.  Also
  31. someone has done an OS/2 port.
  32.  
  33. SOX can now decompress SUN ADPCM compressed sound files.
  34. Internet Talk Radio is now distributed in this format,
  35. I believe.  If not, it soon will be.
  36.  
  37. Caveats:
  38. SOX is intended as the Swiss Army knife of sound
  39. processing tools.  It doesn't do anything very well,
  40. but sooner or later it comes in very handy.
  41. SOX is really only useable day-to-day if you
  42. hide the wacky options with one-line shell scripts.
  43.  
  44. Channel averaging doesn't work.  The software architecture
  45. of stereo & quad is bogus.
  46.  
  47. Installing:
  48. Use the DOS, Unix, Amiga, OS2, or OS9 Makefile as appropriate.
  49. The Makefile needs one option set: -DSYSV if you're on a
  50. System V machine, or -DBSD if you're on a BSD-ish machine.
  51. See the INSTALL file for more detailed instructions.
  52. There are three DOS Makefiles: Makefile.bor for pre-3.0 
  53. Borland C, Makefile.b30 for Borland 3.0, and Makefile.c70
  54. for Microsoft C 7.0.  OS2 needs the two OS2 Makefile-type
  55. programs.  OS9 needs Makefile.os9 for Microware Ultra C.
  56.  
  57. After compiling, run 'tests.sh'.  It should print nothing.  This
  58. indicates that data is copied correctly.  By reading the tests
  59. you may see how to make a sound sample file which you can play.
  60. 'monkey.au' and 'monkey.voc' are a short lo-fi monkey screech
  61. in two supported file formats, to help you ensure that Sound 
  62. Tools works.  Note: 'tests.sh' works only under the Unix sh(1) 
  63. shell.  Use 'tests.com' under VMS.
  64.  
  65. Then, run 'testall.sh'.  This copies monkey.voc into all other
  66. supported file formats, making files in /tmp.  Then, it
  67. translates those formats back into .voc format.  This
  68. ensures (slightly) that all of the readers & writers don't 
  69. core-dump.
  70.  
  71. Now, read TIPS and CHEAT.  These give a background on how
  72. SOX deals with sound files and how to convert this format
  73. to that format, with examples for the most popular formats.
  74.  
  75. SOX uses file suffices to determine the nature of a sound sample file.
  76. If it finds the suffix in its list, it uses the appropriate read
  77. or write handler to deal with that file.  You may override the suffix
  78. by giving a different type via the '-t type' argument.  See the manual
  79. page for more information.  The 'tests.sh' script illustrates various
  80. sox usages.
  81.  
  82. SOX has an auto-detect feature that attempts to figure out
  83. the nature of an unmarked sound sample.  It works very well.
  84. This is the 'auto' file format.
  85.  
  86. I hope to inspire the creation of a common base of sound processing
  87. tools for computer multimedia work, similar to the PBM toolkit for 
  88. image manipulation.
  89.  
  90. Sound Tools may be used for any purpose.  Source
  91. distributions must include the copyright notices.  Binary
  92. distributions must include acknowledgements to the creators.
  93. The files I wrote are copyright Lance Norskog.
  94. The contributed files are copyright by their respective authors.
  95.  
  96. When you have minor changes to contribute, it's OK to post
  97. them; if you have a major release, please send it to me.
  98. I'd like to coordinate the releases and do a peer review.
  99. Please document your changes.  I don't possess every kind
  100. of computer currently sold, and SOX is now beyond the phase
  101. where I can understand and test most of your contributions.
  102. Please make your diff files such that your changes are 
  103. set off with ifdefs, and document them.  
  104.  
  105. Please DO NOT reformat the source code with your favorite 
  106. C beautifier, make 10 fixes, and send me the resulting release.
  107. I do not have the time to fish through 10000 diffs to find 
  108. your 10 fixes.
  109.  
  110. Note: There will be absolutely no more hardware driver
  111. handlers in SOX.  Playing & recording sound samples is
  112. not SOX's job; translation and sound effects is it.
  113. If you wish to write a separate main program (like sox.c)
  114. which uses the SoundTools library and records or plays
  115. on your machine, that's great and I'll be happy to
  116. include it.
  117.  
  118. The majority of SOX features and source code are contributed
  119. by you the user.  Thank you very much for making SOX
  120. a success!
  121.  
  122.     Creator & Maintainer:
  123.         Lance Norskog        thinman@netcom.com
  124.  
  125.     Contributors:
  126.         Guido Van Rossum    guido@cwi.nl
  127.             AU, AIFF, AUTO, HCOM, reverse,
  128.             many bug fixes
  129.         Jef Poskanzer        jef@well.sf.ca.us
  130.             original code for u-law and delay line
  131.         Bill Neisius        bill%solaria@hac2arpa.hac.com 
  132.             DOS port, 8SVX, Sounder, Soundtool formats
  133.             Apollo fixes, stat with auto-picker
  134.         Rick Richardson        rick@digibd.com
  135.             WAV and SB driver handlers, fixes
  136.         David Champion        dgc3@midway.uchicago.edu
  137.             Amiga port 
  138.         Pace Willisson        pace@blitz.com
  139.             Fixes for ESIX
  140.         Leigh Smith        leigh@psychok.dialix.oz.au
  141.             SMP and comment movement support.
  142.         David Sanderson        dws@ssec.wisc.edu
  143.             AIX3.1 fixes
  144.         Glenn Lewis        glewis@pcocd2.intel.com
  145.             AIFF chunking fixes
  146.         Brian Campbell        brianc@quantum.qnx.com
  147.             QNX port and 16-bit fixes
  148.         Chris Adams        gt8741@prism.gatech.edu
  149.             DOS port fixes
  150.         John Kohl        jtkohl@kolvir.elcr.ca.us
  151.             BSD386 port, VOC stereo support
  152.         Ken Kubo        ken@hmcvax.claremont.edu
  153.             VMS port, VOC stereo support
  154.         Frank Gadegast         <phade@cs.tu-berlin.de>
  155.             Microsoft C 7.0 & C Borland 3.0 ports
  156.         David Elliot        <dce@scmc.sony.com>
  157.             CD-R format support
  158.         David Sears        <dns@essnj3.essnjay.com>
  159.             Linux support
  160.         Tom Littlejohn          <tlit@seq1.loc.gov>
  161.             Raw textual data
  162.         Boisy G. Pitre         boisy@microware.com
  163.             OS9 port
  164.                 Sun Microsystems, Guido Van Rossum
  165.                 CCITT G.711, G.721, G.723 implementation
  166.  
  167.         (your name could be here, too)
  168.  
  169.